[work in progress] Add products frontmatter, update applies_to as needed
#1336
Conversation
|
Drive by notes:
|
Yes! elastic/docs-builder#1200 (comment)
Sure. Would we transform the kebab case version to the formatted text version in docs-builder when adding the |
|
How hard or easy would it be for you to add an So instead of: It would become I think it's a relatively easy change now, and it will allow us to add properties in the future. just in case. Also, it makes it semantically clear that it's some sort of ID and not the display name. cc @elastic/docs-engineering Related PR: elastic/docs-builder#1238 WDYT? |
|
Just confirming: The page https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/1336/cloud-account/ contains the meta tags: <meta class="elastic" name="product_name" content="Cloud Hosted,Cloud Serverless">
<meta name="DC.subject" content="Cloud Hosted,Cloud Serverless"> |
|
Closing here. I'll open separate PRs adding |
⚠️ **This PR is dependent on elastic/docs-builder#1256 being merged and changes being released.** Related to #1336 elastic/docs-builder#1200 Adds new `products` frontmatter, which will be used to generate metadata during the build process that the web team will use in the search experience (so users can filter by product). _Note: This reduces the scope of #1336 to only include `products` tags in the frontmatter to unblock updates to the search experience. I'll open a separate PR to update `applies_to` and tag writers to review for their area._ Here's the process: * **Map AsciiDoc/v3 products**: @KOTungseth created a list of all AsciiDoc books mapped to product names. * **Add frontmatter**: I wrote a script that uses Kaarina's list to look at each Markdown file and assign `products` associated with the AsciiDoc book(s) included in `mapped_pages`. * **Format frontmatter**: I standardized the order and format of the frontmatter items. * **Validate frontmatter**: I created [`frontmatter.config.yml`](https://github.com/elastic/docs-content/blob/add-product-tags/frontmatter.config.yml) and checked against it to make sure all frontmatter keys and product values are valid. (Note: I haven't checked that all the values of `deployment` and `serverless` options are valid/correctly formatted.) cc @KOTungseth @reakaleek @zumwalt --------- Co-authored-by: Kaarina Tungseth <[email protected]>
Related to elastic/docs-builder#1200
Adds new
productsfrontmatter, which will be used to generate metadata during the build process that the web team will use in the search experience (so users can filter by product). It also checksapplies_toand adds additional items based on the products that are covered on the page.Here's the process:
applies_tobadges associated with the products covered in that bookproductsassociated with the AsciiDoc book(s) included inmapped_pages.applies_tobadges for that page and compare it to the list of allapplies_tobadges mapped to the AsciiDoc book(s) included in that page'smapped_pages.applies_tobadges, it adds them.applies_tobadges that aren't associated with themapped_pages, it preserves them (no existing badges should be deleted).frontmatter.config.ymland checked against it to make sure all frontmatter keys and product values are valid. (Note: I haven't checked that all the values ofdeploymentandserverlessoptions are valid/correctly formatted.)cc @KOTungseth @reakaleek